<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>FormattedDiskPage (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="FormattedDiskPage (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FormattedDiskPage.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hwpf/model/FootnoteReferenceDescriptor.html" title="class in org.apache.poi.hwpf.model"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/hwpf/model/FSPA.html" title="class in org.apache.poi.hwpf.model"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hwpf/model/FormattedDiskPage.html" target="_top">FRAMES</a></li>
<li><a href="FormattedDiskPage.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.hwpf.model</p>
<h2 title="Class FormattedDiskPage" class="title">Class FormattedDiskPage</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.poi.hwpf.model.FormattedDiskPage</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Direct Known Subclasses:</dt>
<dd><a href="../../../../../org/apache/poi/hwpf/model/CHPFormattedDiskPage.html" title="class in org.apache.poi.hwpf.model">CHPFormattedDiskPage</a>, <a href="../../../../../org/apache/poi/hwpf/model/PAPFormattedDiskPage.html" title="class in org.apache.poi.hwpf.model">PAPFormattedDiskPage</a></dd>
</dl>
<hr>
<br>
<pre><a href="../../../../../org/apache/poi/util/Internal.html" title="annotation in org.apache.poi.util">@Internal</a>
public abstract class <strong>FormattedDiskPage</strong>
extends java.lang.Object</pre>
<div class="block">Represents an FKP data structure. This data structure is used to store the
 grpprls of the paragraph and character properties of the document. A grpprl
 is a list of sprms(decompression operations) to perform on a parent style.

 The style properties for paragraph and character runs
 are stored in fkps. There are PAP fkps for paragraph properties and CHP fkps
 for character run properties. The first part of the fkp for both CHP and PAP
 fkps consists of an array of 4 byte int offsets in the main stream for that
 Paragraph's or Character run's text. The ending offset is the next
 value in the array. For example, if an fkp has X number of Paragraph's
 stored in it then there are (x + 1) 4 byte ints in the beginning array. The
 number X is determined by the last byte in a 512 byte fkp.

 CHP and PAP fkps also store the compressed styles(grpprl) that correspond to
 the offsets on the front of the fkp. The offset of the grpprls is determined
 differently for CHP fkps and PAP fkps.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Ryan Ackley</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/FormattedDiskPage.html#_crun">_crun</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/FormattedDiskPage.html#_fkp">_fkp</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/FormattedDiskPage.html#_offset">_offset</a></strong></code>&nbsp;</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!--   -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/FormattedDiskPage.html#FormattedDiskPage()">FormattedDiskPage</a></strong>()</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/FormattedDiskPage.html#FormattedDiskPage(byte[], int)">FormattedDiskPage</a></strong>(byte[]&nbsp;documentStream,
                 int&nbsp;offset)</code>
<div class="block">Uses a 512-byte array to create a FKP</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/FormattedDiskPage.html#getEnd(int)">getEnd</a></strong>(int&nbsp;index)</code>
<div class="block">Used to get the end of the text corresponding to a grpprl in this fkp.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>protected abstract byte[]</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/FormattedDiskPage.html#getGrpprl(int)">getGrpprl</a></strong>(int&nbsp;index)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/FormattedDiskPage.html#getStart(int)">getStart</a></strong>(int&nbsp;index)</code>
<div class="block">Used to get a text offset corresponding to a grpprl in this fkp.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/poi/hwpf/model/FormattedDiskPage.html#size()">size</a></strong>()</code>
<div class="block">Used to get the total number of grrprl's stored int this FKP</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="_fkp">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_fkp</h4>
<pre>protected&nbsp;byte[] _fkp</pre>
</li>
</ul>
<a name="_crun">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>_crun</h4>
<pre>protected&nbsp;int _crun</pre>
</li>
</ul>
<a name="_offset">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>_offset</h4>
<pre>protected&nbsp;int _offset</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!--   -->
</a>
<h3>Constructor Detail</h3>
<a name="FormattedDiskPage()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FormattedDiskPage</h4>
<pre>public&nbsp;FormattedDiskPage()</pre>
</li>
</ul>
<a name="FormattedDiskPage(byte[], int)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FormattedDiskPage</h4>
<pre>public&nbsp;FormattedDiskPage(byte[]&nbsp;documentStream,
                 int&nbsp;offset)</pre>
<div class="block">Uses a 512-byte array to create a FKP</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getStart(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getStart</h4>
<pre>protected&nbsp;int&nbsp;getStart(int&nbsp;index)</pre>
<div class="block">Used to get a text offset corresponding to a grpprl in this fkp.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - The index of the property in this FKP</dd>
<dt><span class="strong">Returns:</span></dt><dd>an int representing an offset in the "WordDocument" stream</dd></dl>
</li>
</ul>
<a name="getEnd(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getEnd</h4>
<pre>protected&nbsp;int&nbsp;getEnd(int&nbsp;index)</pre>
<div class="block">Used to get the end of the text corresponding to a grpprl in this fkp.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>index</code> - The index of the property in this fkp.</dd>
<dt><span class="strong">Returns:</span></dt><dd>an int representing an offset in the "WordDocument" stream</dd></dl>
</li>
</ul>
<a name="size()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public&nbsp;int&nbsp;size()</pre>
<div class="block">Used to get the total number of grrprl's stored int this FKP</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The number of grpprls in this FKP</dd></dl>
</li>
</ul>
<a name="getGrpprl(int)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getGrpprl</h4>
<pre>protected abstract&nbsp;byte[]&nbsp;getGrpprl(int&nbsp;index)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FormattedDiskPage.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/poi/hwpf/model/FootnoteReferenceDescriptor.html" title="class in org.apache.poi.hwpf.model"><span class="strong">PREV CLASS</span></a></li>
<li><a href="../../../../../org/apache/poi/hwpf/model/FSPA.html" title="class in org.apache.poi.hwpf.model"><span class="strong">NEXT CLASS</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/poi/hwpf/model/FormattedDiskPage.html" target="_top">FRAMES</a></li>
<li><a href="FormattedDiskPage.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_summary">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor_detail">CONSTR</a>&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
